Fix blank screen is shown when opening a report screen after relaunching app #37596

bernhardoj · 2024-03-01T11:54:50Z

Details

The withOnyx returns null when the data is still loading. We already put some initialValue to the required onyx data, but Onyx has a bug that doesn't accept falsey initialValue. This PR also fixes some App issue that arise after fixing the onyx bug.

Fixed Issues

$ #35906
PROPOSAL: #35906 (comment)

Tests

Same as QA Steps

Verify that no errors appear in the JS console

Offline tests

Same as QA Steps

QA Steps

A.

Close the app if it's opened
Reopen the app
Open any chat
Do step 3 on several chats
Verify the chat screen/skeleton is shown instead of blank screen for a brief moment

B.

Open a workspace chat
Turn off internet connection
Request money from the workspace
Open the transaction thread
Verify you are able to see the transaction thread details instead of infinite loading

C.

Create a new workspace room
Verify you are navigated to the workspace room chat and not to concierge chat
Verify the room name is correct

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Screen.Recording.2024-02-14.at.13.58.29.mov

New.Expensify.Dev.1.mp4

Android: mWeb Chrome

Screen.Recording.2024-02-14.at.14.01.06.mov

Screen.Recording.2024-02-27.at.16.05.34.mov

iOS: Native

Screen.Recording.2024-02-14.at.14.05.55.mov

Screen.Recording.2024-02-27.at.15.59.42.mov

iOS: mWeb Safari

Screen.Recording.2024-02-14.at.14.01.41.mov

Screen.Recording.2024-02-27.at.15.54.32.mov

MacOS: Chrome / Safari

Screen.Recording.2024-02-14.at.14.06.30.mov

Screen.Recording.2024-02-27.at.15.48.19.mov

MacOS: Desktop

Screen.Recording.2024-02-14.at.14.07.33.mov

Screen.Recording.2024-02-27.at.15.50.39.mov

melvin-bot · 2024-03-01T11:54:55Z

@ntdiary Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

bernhardoj · 2024-03-01T11:56:56Z

src/libs/actions/Report.ts

-    if (isEmptyObject(report)) {
-        optimisticData[0].onyxMethod = Onyx.METHOD.SET;
-    }
-


This is to fix all the found issues from our PR
#37247, #37234, #37300, and #37251.

The root cause is explained here

bernhardoj · 2024-03-01T12:17:26Z

There are 2 issues left however and they have the same issue too.

Chat Report is shown as the report name when creating a new workspace room

The report name is overwritten with the default name here because the onyx data is not ready yet.

App/src/libs/actions/Report.ts

Lines 572 to 576 in 39a257d

    
           const optimisticReport = reportActionsExist(reportID) 
        
               ? {} 
        
               : { 
        
                     reportName: allReports?.[reportID]?.reportName ?? CONST.REPORT.DEFAULT_REPORT_NAME, 
        
                 };

OpenReport is still called even though we have a comment here mentioning that we use SET so the report data is available immediately

App/src/libs/actions/Report.ts

Lines 1767 to 1770 in 39a257d

    
           // Onyx.set is used on the optimistic data so that it is present before navigating to the workspace room. With Onyx.merge the workspace room reportID is not present when 
        
           // fetchReportIfNeeded is called on the ReportScreen, so openReport is called which is unnecessary since the optimistic data will be stored in Onyx. 
        
           // Therefore, Onyx.set is used instead of Onyx.merge. 
        
           const optimisticData: OnyxUpdate[] = [

so we can avoid calling OpenReport.

App/src/pages/home/ReportScreen.js

Lines 355 to 362 in 39a257d

    
           // It possible that we may not have the report object yet in Onyx yet e.g. we navigated to a URL for an accessible report that 
        
           // is not stored locally yet. If report.reportID exists, then the report has been stored locally and nothing more needs to be done. 
        
           // If it doesn't exist, then we fetch the report from the API. 
        
           if (report.reportID && report.reportID === getReportID(route) && !isLoadingInitialReportActions) { 
        
               return; 
        
           } 
        
           Report.openReport(reportIDFromPath);

However, the report data is not available immediately.

The optimisticData is updated through Onyx.update calls which use promises that delay the operation.
https://github.com/Expensify/react-native-onyx/blob/034aa0e7858ec4f8a859117b5f527c793b0a61f7/lib/Onyx.js#L1494-L1518

We can fix this using Onyx.set or Onyx.multiSet directly, so the report (and other required data) is 100% immediately available. So far, I have used this in Report.openReport and Report.addPolicyReport, and it works well. What do you think?

ntdiary · 2024-03-06T15:11:01Z

Just finished several pending migration PRs in these days, I expect to have time tomorrow to revisit the above problems. :)

ntdiary · 2024-03-11T13:45:16Z

Still investigating the related issues.

bernhardoj · 2024-03-13T09:09:53Z

Or perhaps we should remove the allowStaleData because the component expects the report data to be available (not pending to set/merge) when mounted. So far I can't notice the blank screen after removing it and returning undefined from reportWithoutHasDraftSelector instead of null.

ntdiary · 2024-04-09T12:32:33Z

Or perhaps we should remove the allowStaleData because the component expects the report data to be available (not pending to set/merge) when mounted. So far I can't notice the blank screen after removing it and returning undefined from reportWithoutHasDraftSelector instead of null.

Hi, @bernhardoj, Did you mean that we only need to remove allowStaleData in ReportScreen? I can still get a black screen. 🤔

We can fix this using Onyx.set or Onyx.multiSet directly, so the report (and other required data) is 100% immediately available.

As for this part, we had a discussion in other places and felt that it is better to avoid using the set method as much as possible, so I wanted to investigate if there are other solutions. :)

bernhardoj · 2024-04-11T14:20:37Z

Hmm, the only idea left I have is to replace withOnyx with useOnyx hook.

ntdiary · 2024-04-12T12:02:23Z

Hmm, the only idea left I have is to replace withOnyx with useOnyx hook.

Thank you! I'll investigate this solution next week.

ntdiary · 2024-04-19T15:58:32Z

I'm experimenting with switching to useOnyx today, and it feels like a promising direction. However, we still need to consider a fair number of cases and performance, will continue to delve deeper over the weekend, and expect to provide further updates next Monday.

ntdiary · 2024-04-22T15:39:02Z

test.mp4

The investigation into the issue is still progressing slowly. It seems there is still some delay when the report is opened first. In my previous tests, there have been instances where the skeleton didn't appear immediately, and sometimes the header didn't show up right away either. This week, I'll focus on this issue and another refocusing issue. Also, if necessary, will seek more inputs in the performance channel. :)

bernhardoj · 2024-04-22T16:01:22Z

Based on the video, looks like the report screen is rendered immediately as shown by the (broken) composer, I will check it too tomorrow to see if I can reproduce and find something about it.

ntdiary · 2024-04-25T15:30:54Z

App/src/libs/actions/Report.ts

Line 680 in 1abbf42

    
           reportName: allReports?.[reportID]?.reportName ?? CONST.REPORT.DEFAULT_REPORT_NAME,

This line of code was introduced here, and I'm also testing to remove it.
#12157 (comment)

ntdiary · 2024-04-29T14:08:09Z

So far, using useOnyx has indeed significantly improved screen loading speed. However, there are still some potential bugs to be aware of (e.g., in my last case, I encountered an infinite loop when opening no.1's Workspace. But it could also be a problem with my own code logic, which needs further verification). Additionally, considering the complexity of this issue, I may later ask on Slack if it's possible to increase the bounty for this issue. 😄

Regarding the broken composer, I think it also occurs in the production environment, so we can ignore it for now.

test.mp4

bernhardoj · 2024-04-30T06:58:53Z

This line of code was introduced here, and I'm also testing to remove it.

I think we can keep it like that. To solve the name issue in my comment here, I update the code to call OpenReport only after the report onyx is loaded. I think we can convert only some of the onyx data to useOnyx to reduce the risk of regression. I have pushed the update so you can compare and test it.

ntdiary · 2024-05-14T14:25:39Z

I think we can keep it like that. To solve the name issue in my comment #37596 (comment), I update the code to call OpenReport only after the report onyx is loaded. I think we can convert only some of the onyx data to useOnyx to reduce the risk of regression. I have pushed the update so you can compare and test it.

Vacation is over, time to tackle this challenge again. 😂 In my test, the middle list area still shows a blank screen. maybe we can show the skeleton instead?

test.mp4

bernhardoj · 2024-05-15T06:33:38Z

Ok I can reproduce the blank list. I checked the onyx data of ReportActionsView

App/src/pages/home/report/ReportActionsView.tsx

Lines 622 to 633 in 7ef8e8c

    
           withOnyx<ReportActionsViewProps, ReportActionsViewOnyxProps>({ 
        
               session: { 
        
                   key: ONYXKEYS.SESSION, 
        
               }, 
        
               transactionThreadReportActions: { 
        
                   key: ({transactionThreadReportID}) => `${ONYXKEYS.COLLECTION.REPORT_ACTIONS}${transactionThreadReportID}`, 
        
                   canEvict: false, 
        
                   selector: (reportActions: OnyxEntry<OnyxTypes.ReportActions>) => ReportActionsUtils.getSortedReportActionsForDisplay(reportActions, true), 
        
               }, 
        
               transactionThreadReport: { 
        
                   key: ({transactionThreadReportID}) => `${ONYXKEYS.COLLECTION.REPORT}${transactionThreadReportID}`, 
        
               },

and it's the transactionThreadReport that's not available yet, so I set the initial value to it.

ntdiary · 2024-05-16T13:35:31Z

src/pages/home/ReportScreen.tsx

@@ -489,6 +467,16 @@ function ReportScreen({
        // eslint-disable-next-line react-hooks/exhaustive-deps
    }, []);

+    useEffect(() => {
+        // Call OpenReport only if we are not linking to a message or the report is not available yet
+        if (reportResult.status === 'loading' || (reportActionIDFromRoute && report.reportID)) {


Looks much better now! Also, just a minor change request, we have an isLoadingOnyxValue util function, so defining a variable might be better than using reportResult.status directly.(e.g., const isLoadingReportOnyx = isLoadingOnyxValue(reportResult), which will help clean up the logic of this component in the future. :)

Oh, nice one. Updated.

bernhardoj · 2024-05-16T14:09:17Z

Btw, I'm still considering whether to include the report onyx loading state to isLoading here

App/src/pages/home/ReportScreen.tsx

Line 393 in a03fecc

    
           const isLoading = !reportIDFromRoute || (!isSidebarLoaded && !isReportOpenInRHP) || PersonalDetailsUtils.isPersonalDetailsEmpty();

I think we should add it. Do you agree?

ntdiary · 2024-05-17T14:41:31Z

Btw, I'm still considering whether to include the report onyx loading state to isLoading here

App/src/pages/home/ReportScreen.tsx

Line 393 in a03fecc

const isLoading = !reportIDFromRoute || (!isSidebarLoaded && !isReportOpenInRHP) || PersonalDetailsUtils.isPersonalDetailsEmpty();

I think we should add it. Do you agree?

I've also attempted something similar before. This might involve cleaning up the loading related code. I'll first ask about it on Slack. :)

ntdiary · 2024-05-23T12:33:11Z

Hi @bernhardoj, after discussion, we've decided not to make further changes for now, The loading and other withOnyx improvement can be addressed in another ticket later. Do you mind merging the main branch to pass the ts check(I know the error isn't caused by this PR)? :)

bernhardoj · 2024-05-23T13:09:45Z

Thanks for the updated! Merged with main

ntdiary · 2024-05-23T13:44:05Z

Reviewer Checklist

I have verified the author checklist is complete (all boxes are checked off).
I verified the correct issue is linked in the ### Fixed Issues section above
I verified testing steps are clear and they cover the changes made in this PR
- I verified the steps for local testing are in the Tests section
- I verified the steps for Staging and/or Production testing are in the QA steps section
- I verified the steps cover any possible failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
- I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
I checked that screenshots or videos are included for tests on all platforms
I included screenshots or videos for tests on all platforms
I verified tests pass on all platforms & I tested again on:
- Android: Native
- Android: mWeb Chrome
- iOS: Native
- iOS: mWeb Safari
- MacOS: Chrome / Safari
- MacOS: Desktop
If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
I verified proper code patterns were followed (see Reviewing the code)
- I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick).
- I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
- I verified that comments were added to code that is not self explanatory
- I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
- I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
- I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
- I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
- I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
- I verified the JSDocs style guidelines (in STYLE.md) were followed
If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
I verified that this PR follows the guidelines as stated in the Review Guidelines
I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar have been tested & I retested again)
I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
If a new component is created I verified that:
- A similar component doesn't exist in the codebase
- All props are defined accurately and each prop has a /** comment above it */
- The file is named correctly
- The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
- The only data being stored in the state is data necessary for rendering and nothing else
- For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
- Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
- All JSX used for rendering exists in the render method
- The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
If any new file was added I verified that:
- The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
If a new CSS style is added I verified that:
- A similar style doesn't already exist
- The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG)
If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
If the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label and/or tagged @Expensify/design so the design team can review the changes.
If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native

37596-android-native.mp4

Android: mWeb Chrome

37596-android-chrome.mp4

iOS: Native

37596-ios-native.mp4

iOS: mWeb Safari

37596-ios-safari.mp4

MacOS: Chrome / Safari

37596-web.mp4

MacOS: Desktop

37596-desktop.mp4

ntdiary

LGTM. :)
Additionally, A and C are online cases, B is offline. And B, C are regression cases that were reported previously.

B.mp4

C.mp4

ntdiary · 2024-05-23T22:57:52Z

All yours, @yuwenmemon. I haven't returned to the assignment queue, so the automatic assignment hasn't taken effect. :)

yuwenmemon · 2024-05-28T20:22:31Z

Thanks!

OSBotify · 2024-05-29T09:41:39Z

🚀 Deployed to staging by https://github.com/yuwenmemon in version: 1.4.77-0 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅

OSBotify · 2024-05-30T21:24:28Z

🚀 Deployed to production by https://github.com/puneetlath in version: 1.4.77-11 🚀

platform	result
🤖 android 🤖	failure ❌
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅

OSBotify · 2024-05-30T22:36:26Z

🚀 Deployed to production by https://github.com/puneetlath in version: 1.4.77-11 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅

bernhardoj added 4 commits February 29, 2024 18:03

don't overwrite report

b77c550

update onyx

92ed833

Merge branch 'main' into fix/35906-blank-screen-when-open-chat

31d9c37

Merge branch 'main' into fix/35906-blank-screen-when-open-chat

db570de

bernhardoj requested a review from a team as a code owner March 1, 2024 11:54

melvin-bot bot removed the request for review from a team March 1, 2024 11:54

melvin-bot bot requested a review from ntdiary March 1, 2024 11:54

bernhardoj commented Mar 1, 2024

View reviewed changes

ntdiary mentioned this pull request Apr 29, 2024

Try to refactor the logic regarding refocusing when the modal is closed #29199

Closed

bernhardoj added 2 commits April 30, 2024 12:39

Merge branch 'main' into fix/35906-blank-screen-when-open-chat

7acb886

use useOnyx hook

56191cd

bernhardoj added 5 commits April 30, 2024 15:00

remove console log

6ac5bf3

fallback to empty screen

d5b4278

remove code for debugging

49867e7

fix wrong onyxkey name

d4b1d07

fix lint

05d7188

supress lint

4df4c34

bernhardoj added 3 commits May 15, 2024 13:52

Merge branch 'main' into fix/35906-blank-screen-when-open-chat

7dcfb99

remove dupe openreport

9f79f27

set initial value to empty object

2d039ab

ntdiary suggested changes May 16, 2024

View reviewed changes

bernhardoj added 2 commits May 16, 2024 21:59

Merge branch 'main' into fix/35906-blank-screen-when-open-chat

3a0258a

use isLoadingOnyxValue

774048b

prettier

01509e2

Merge branch 'main' into fix/35906-blank-screen-when-open-chat

049838b

ntdiary approved these changes May 23, 2024

View reviewed changes

yuwenmemon self-requested a review May 24, 2024 00:20

yuwenmemon approved these changes May 28, 2024

View reviewed changes

yuwenmemon merged commit 6b4df86 into Expensify:main May 28, 2024
17 checks passed

melvin-bot bot mentioned this pull request May 30, 2024

[HOLD for payment 2024-06-06] [$500] Android - Blank screen appears when transitioning between pages after relaunching app #35906

Closed

6 tasks

bernhardoj mentioned this pull request Oct 1, 2024

[$250] 3 OpenReport API calls for the same report #49948

Open

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix blank screen is shown when opening a report screen after relaunching app #37596

Fix blank screen is shown when opening a report screen after relaunching app #37596

bernhardoj commented Mar 1, 2024

melvin-bot bot commented Mar 1, 2024

bernhardoj Mar 1, 2024

bernhardoj commented Mar 1, 2024

ntdiary commented Mar 6, 2024 •

edited

Loading

ntdiary commented Mar 11, 2024

bernhardoj commented Mar 13, 2024

ntdiary commented Apr 9, 2024

bernhardoj commented Apr 11, 2024

ntdiary commented Apr 12, 2024

ntdiary commented Apr 19, 2024

ntdiary commented Apr 22, 2024 •

edited

Loading

bernhardoj commented Apr 22, 2024

ntdiary commented Apr 25, 2024

ntdiary commented Apr 29, 2024

bernhardoj commented Apr 30, 2024

ntdiary commented May 14, 2024

bernhardoj commented May 15, 2024

ntdiary May 16, 2024

bernhardoj May 16, 2024

bernhardoj commented May 16, 2024

ntdiary commented May 17, 2024

ntdiary commented May 23, 2024

bernhardoj commented May 23, 2024

ntdiary commented May 23, 2024 •

edited

Loading

ntdiary left a comment •

edited

Loading

ntdiary commented May 23, 2024

yuwenmemon commented May 28, 2024

OSBotify commented May 29, 2024

OSBotify commented May 30, 2024

OSBotify commented May 30, 2024

Fix blank screen is shown when opening a report screen after relaunching app #37596

Fix blank screen is shown when opening a report screen after relaunching app #37596

Conversation

bernhardoj commented Mar 1, 2024

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Mar 1, 2024

bernhardoj Mar 1, 2024

Choose a reason for hiding this comment

bernhardoj commented Mar 1, 2024

ntdiary commented Mar 6, 2024 • edited Loading

ntdiary commented Mar 11, 2024

bernhardoj commented Mar 13, 2024

ntdiary commented Apr 9, 2024

bernhardoj commented Apr 11, 2024

ntdiary commented Apr 12, 2024

ntdiary commented Apr 19, 2024

ntdiary commented Apr 22, 2024 • edited Loading

bernhardoj commented Apr 22, 2024

ntdiary commented Apr 25, 2024

ntdiary commented Apr 29, 2024

bernhardoj commented Apr 30, 2024

ntdiary commented May 14, 2024

bernhardoj commented May 15, 2024

ntdiary May 16, 2024

Choose a reason for hiding this comment

bernhardoj May 16, 2024

Choose a reason for hiding this comment

bernhardoj commented May 16, 2024

ntdiary commented May 17, 2024

ntdiary commented May 23, 2024

bernhardoj commented May 23, 2024

ntdiary commented May 23, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

ntdiary left a comment • edited Loading

Choose a reason for hiding this comment

ntdiary commented May 23, 2024

yuwenmemon commented May 28, 2024

OSBotify commented May 29, 2024

OSBotify commented May 30, 2024

OSBotify commented May 30, 2024

ntdiary commented Mar 6, 2024 •

edited

Loading

ntdiary commented Apr 22, 2024 •

edited

Loading

ntdiary commented May 23, 2024 •

edited

Loading

ntdiary left a comment •

edited

Loading